home *** CD-ROM | disk | FTP | other *** search
/ Amiga Magazin: Amiga-CD 1996 March / Amiga-CD 1996 #3.iso / pd-software / mui_3.1 / developer / autodocs / mui_bodychunk.doc < prev    next >
Text File  |  1996-01-19  |  3KB  |  81 lines
  1. TABLE OF CONTENTS
  2.  
  3. Bodychunk.mui/Bodychunk.mui
  4. Bodychunk.mui/MUIA_Bodychunk_Body
  5. Bodychunk.mui/MUIA_Bodychunk_Compression
  6. Bodychunk.mui/MUIA_Bodychunk_Depth
  7. Bodychunk.mui/MUIA_Bodychunk_Masking
  8. Bodychunk.mui/Bodychunk.mui
  9.  
  10.     Big and colorful images (e.g. About-Logos) usually take lots
  11.     of space when stored in a traditional BitMap structure. To
  12.     save memory, you can decide to have the picture compressed
  13.     in your code and use the Bodychunk class instead of the
  14.     Bitmap class for displaying. MUI will then automatically
  15.     decompress your image when its about to appear in a
  16.     window.
  17.  
  18.     Since Bodychunk class is a subclass of Bitmap class, you can
  19.     of course use all the Bitmaps remapping and transparency
  20.     features.
  21. Bodychunk.mui/MUIA_Bodychunk_Body
  22.  
  23.     NAME
  24.     MUIA_Bodychunk_Body -- (V8 ) [ISG], UBYTE *
  25.  
  26.     FUNCTION
  27.     Specify a pointer to the BODY data of your picture. This BODY
  28.     data must follow normal IFF/ILBM conventions.
  29.  
  30.     You have to supply MUIA_Bitmap_Width, MUIA_Bitmap_Height and
  31.     MUIA_Bodychunk_Depth to describe the contents of the BODY
  32.     data, otherwise MUI will fail to decompress it.
  33.  
  34.     SEE ALSO
  35.     MUIA_Bodychunk_Depth, MUIA_Bodychunk_Compression,
  36.     MUIA_Bodychunk_Masking
  37. Bodychunk.mui/MUIA_Bodychunk_Compression
  38.  
  39.     NAME
  40.     MUIA_Bodychunk_Compression -- (V8 ) [ISG], UBYTE
  41.  
  42.     FUNCTION
  43.     MUI is able to uncompress byte&run compressed BODY chunks
  44.     automatically. If your data is compressed, you must
  45.     supply a value of cmpByteRun1 (==1) for this tag. Other
  46.     compression techniques are not supported.
  47.  
  48.     Omitting this tag or setting it to 0 indicates that the
  49.     BODY data is uncompressed. Using the Bodychunk class
  50.     doesn't make much sense in this case since its main
  51.     purpose is to save memory for big images.
  52.  
  53.     SEE ALSO
  54.     MUIA_Bodychunk_Masking, MUIA_Bodychunk_Body
  55. Bodychunk.mui/MUIA_Bodychunk_Depth
  56.  
  57.     NAME
  58.     MUIA_Bodychunk_Depth -- (V8 ) [ISG], LONG
  59.  
  60.     FUNCTION
  61.     Specify the depth of your picture here. This tag is
  62.     required for correct BODY chunk parsing. Also remember
  63.     to use MUIA_Bodychunk_Masking if your BODY data contains
  64.     a masking bitplane.
  65.  
  66.     SEE ALSO
  67.     MUIA_Bodychunk_Body, MUIA_Bodychunk_Masking
  68. Bodychunk.mui/MUIA_Bodychunk_Masking
  69.  
  70.     NAME
  71.     MUIA_Bodychunk_Masking -- (V8 ) [ISG], UBYTE
  72.  
  73.     FUNCTION
  74.     You must indicate if your BODY data contains a masking
  75.     plane. Currently, MUI does not use this masking plane
  76.     for any purpose, but this attribute is required to
  77.     allow correct parsing of the BODY data.
  78.  
  79.     SEE ALSO
  80.     MUIA_Bodychunk_Body, MUIA_Bodychunk_Compression
  81.